<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: /bb/mbigc/mbig5696/git/quantum_external/src/interface/quantum_ithread_context_base.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d0/d9b/quantum__ithread__context__base_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">quantum_ithread_context_base.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">** Copyright 2018 Bloomberg Finance L.P.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">** Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">** you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">** You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">**     http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">** Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">** distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">** See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">** limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef BLOOMBERG_QUANTUM_ITHREAD_CONTEXT_BASE_H</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define BLOOMBERG_QUANTUM_ITHREAD_CONTEXT_BASE_H</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;future&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;chrono&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;quantum/interface/quantum_icontext_base.h&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a> {</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">namespace </span>quantum {</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> RET&gt;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">class </span>Context;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">//                                 interface IThreadContextBase</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html">   34</a></span>&#160;<span class="comment"></span><span class="keyword">struct </span><a class="code" href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html">IThreadContextBase</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html">IContextBase</a></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;{</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#a95643a462eecd0836f9fd348703f77a2">   36</a></span>&#160;    <span class="keyword">using</span> <a class="code" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#ac92e5d294479f777fd01f5621e4f8db9">Ptr</a> = std::shared_ptr&lt;IThreadContextBase&gt;;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    </div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#ab76735c9a8cbb1f8ff193d122b70f642">wait</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    </div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <span class="keyword">virtual</span> std::future_status <a class="code" href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#a84d767595a4b8acb729b759c500a4cba">waitFor</a>(std::chrono::milliseconds timeMs) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    </div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#a52d3339262492bdac8e51d6317a5c4e3">waitAt</a>(<span class="keywordtype">int</span> num) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    </div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keyword">virtual</span> std::future_status <a class="code" href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#ab3ad8ed1eae83ea16a8a6cda36243fe4">waitForAt</a>(<span class="keywordtype">int</span> num, std::chrono::milliseconds timeMs) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    </div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#a56cf07f98b78dee7ab87a4899feffda2">waitAll</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;};</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a43309e2c15f17b8d7accac5ba695f1e3">   71</a></span>&#160;<span class="keyword">using</span> <a class="code" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a43309e2c15f17b8d7accac5ba695f1e3">IThreadContextBasePtr</a> = <a class="code" href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#a95643a462eecd0836f9fd348703f77a2">IThreadContextBase::Ptr</a>;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;}}</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="preprocessor">#endif //BLOOMBERG_QUANTUM_ITHREAD_CONTEXT_BASE_H</span></div><div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadContextBase_html_ab3ad8ed1eae83ea16a8a6cda36243fe4"><div class="ttname"><a href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#ab3ad8ed1eae83ea16a8a6cda36243fe4">Bloomberg::quantum::IThreadContextBase::waitForAt</a></div><div class="ttdeci">virtual std::future_status waitForAt(int num, std::chrono::milliseconds timeMs) const =0</div><div class="ttdoc">Waits for the future in the 'num-th' continuation context to be ready for a maximum of 'timeMs' milli...</div></div>
<div class="ttc" id="namespaceBloomberg_html"><div class="ttname"><a href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:22</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IContextBase_html_ac92e5d294479f777fd01f5621e4f8db9"><div class="ttname"><a href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#ac92e5d294479f777fd01f5621e4f8db9">Bloomberg::quantum::IContextBase::Ptr</a></div><div class="ttdeci">std::shared_ptr&lt; IContextBase &gt; Ptr</div><div class="ttdef"><b>Definition:</b> quantum_icontext_base.h:35</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadContextBase_html_a56cf07f98b78dee7ab87a4899feffda2"><div class="ttname"><a href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#a56cf07f98b78dee7ab87a4899feffda2">Bloomberg::quantum::IThreadContextBase::waitAll</a></div><div class="ttdeci">virtual void waitAll() const =0</div><div class="ttdoc">Wait for all the futures in the continuation chain to be ready.</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadContextBase_html_ab76735c9a8cbb1f8ff193d122b70f642"><div class="ttname"><a href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#ab76735c9a8cbb1f8ff193d122b70f642">Bloomberg::quantum::IThreadContextBase::wait</a></div><div class="ttdeci">virtual void wait() const =0</div><div class="ttdoc">Waits for the future associated with this context to be ready.</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadContextBase_html"><div class="ttname"><a href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html">Bloomberg::quantum::IThreadContextBase</a></div><div class="ttdoc">Exposes methods to manipulate the thread context, especially future wait methods.</div><div class="ttdef"><b>Definition:</b> quantum_ithread_context_base.h:34</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadContextBase_html_a84d767595a4b8acb729b759c500a4cba"><div class="ttname"><a href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#a84d767595a4b8acb729b759c500a4cba">Bloomberg::quantum::IThreadContextBase::waitFor</a></div><div class="ttdeci">virtual std::future_status waitFor(std::chrono::milliseconds timeMs) const =0</div><div class="ttdoc">Waits for the future associated with this context to be ready for a maximum of 'timeMs' milliseconds.</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IContextBase_html"><div class="ttname"><a href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html">Bloomberg::quantum::IContextBase</a></div><div class="ttdoc">This interface exposes shared functionality between IThreadContext and ICoroContext.</div><div class="ttdef"><b>Definition:</b> quantum_icontext_base.h:33</div></div>
<div class="ttc" id="namespaceBloomberg_1_1quantum_html_a43309e2c15f17b8d7accac5ba695f1e3"><div class="ttname"><a href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a43309e2c15f17b8d7accac5ba695f1e3">Bloomberg::quantum::IThreadContextBasePtr</a></div><div class="ttdeci">IThreadContextBase::Ptr IThreadContextBasePtr</div><div class="ttdef"><b>Definition:</b> quantum_ithread_context_base.h:71</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadContextBase_html_a52d3339262492bdac8e51d6317a5c4e3"><div class="ttname"><a href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#a52d3339262492bdac8e51d6317a5c4e3">Bloomberg::quantum::IThreadContextBase::waitAt</a></div><div class="ttdeci">virtual void waitAt(int num) const =0</div><div class="ttdoc">Waits for the future in the 'num-th' continuation context to be ready.</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadContextBase_html_a95643a462eecd0836f9fd348703f77a2"><div class="ttname"><a href="../../da/d4d/structBloomberg_1_1quantum_1_1IThreadContextBase.html#a95643a462eecd0836f9fd348703f77a2">Bloomberg::quantum::IThreadContextBase::Ptr</a></div><div class="ttdeci">std::shared_ptr&lt; IThreadContextBase &gt; Ptr</div><div class="ttdef"><b>Definition:</b> quantum_ithread_context_base.h:36</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="../../dir_650ee533936399e683a30afb9473a469.html">interface</a></li><li class="navelem"><b>quantum_ithread_context_base.h</b></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
